home *** CD-ROM | disk | FTP | other *** search
/ Aminet 1 (Walnut Creek) / Aminet - June 1993 [Walnut Creek].iso / aminet / text / docs / vw12_1.lzh / VW.DOC < prev    next >
Text File  |  1992-01-18  |  19KB  |  413 lines

  1. -------------------------------------------------------------------
  2. VerseWise Amiga v1.2 Copyright Bruce Geerdes 1991,1992
  3. May 9, 1992
  4. -------------------------------------------------------------------
  5.  
  6. SUMMARY
  7.  
  8. VerseWise is a Bible display/search/output program for the Amiga.
  9. It opens a resizeable window on the Workbench screen and allows
  10. one to quickly jump to any scripture, search for verses containing
  11. one to ten specific words, and/or output text to an ASCII file.
  12.  
  13. VerseWise uses the King James (or "Authorized") translation of the
  14. Bible and is freely distributable, as long as it is not done so
  15. for monetary gain.
  16.  
  17. -------------------------------------------------------------------
  18.  
  19. DIFFERENT IMPLEMENTATIONS
  20.  
  21. There are two implementations of VerseWise:  a hard disk based
  22. full Bible, and a floppy disk New Testament.  You need a hard
  23. drive to run the former, as it occupies about 2.2 megabytes of
  24. disk space, with its largest file just under 1.5 megs.  The New
  25. Testament fits on one floppy.
  26.  
  27. -------------------------------------------------------------------
  28.  
  29. SETTING UP
  30.  
  31. New Testament:  It's already set up.  Skip to the next section!
  32.  
  33. Full Bible:
  34.  
  35. You should have three disks:  VerseWise, Data1, & Data2.
  36.  
  37. To set VerseWise up, all you need to do is copy the VerseWise
  38. directory from the VerseWise disk on to your hard drive. The files
  39. in the directory (at last count) are:
  40.  
  41.     VW(.info)
  42.     VW.doc(.info)
  43.     Install_text(.info)
  44.     data.boo
  45.     data.cha
  46.     data.loo
  47.     data.num
  48.     data.ver
  49.  
  50. From your hard drive, run the Install_text program and it will
  51. request the Data1 and Data2 disks when it needs them and create
  52. the "data.tex" file.  Keep the disks as a backup.
  53.  
  54. -------------------------------------------------------------------
  55.  
  56. RUNNING VERSEWISE
  57.  
  58. You may start VerseWise from the Workbench by double-clicking on
  59. the "VW" icon, or if you are in CLI, typing "run VW".  By running
  60. VerseWise two or more times and resizing and rearranging the
  61. windows you can compare two or more passages side by side.  The
  62. only restriction is the amount of available RAM your system has.
  63. Each copy of the New Testament uses around 274k, while the full
  64. Bible needs about 511k per copy. (Your mileage will vary.)  VW_LO,
  65. provided with the full Bible version, uses about 386k per copy,
  66. but is slower because it does more disk accessing.  If you have
  67. very little free RAM, you may need to use it.
  68.  
  69. The window will open a certain size and in a certain location.
  70. You may resize the window and place it differently.  If you want
  71. the window to be opened such the next time you run VerseWise,
  72. choose "Save Prefs" under the "VerseWise" menu.
  73.  
  74. -------------------------------------------------------------------
  75.  
  76. MOVING AROUND
  77.  
  78. If you are using the New Testament version, and this is the first
  79. time you are running the program, you will start out at Matthew
  80. chapter 1, verse 1. (The beginning of each verse is marked by its
  81. chapter number [colon] verse number.)  If you are running the full
  82. Bible version, you will begin at Genesis 1:1.  When you quit, VW
  83. will save your position and place you there the next time you run
  84. it.
  85.  
  86. The book you are currently in is displayed in VerseWise's window
  87. title, which changes as the first line of the window moves from one
  88. book to another.  The end of one book and the beginning of the
  89. following book can be displayed in the window at the same time;
  90. whichever book the first line of the window is in will be displayed
  91. in the window title.
  92.  
  93. The scroll bar in the right border of the window approximates
  94. where you are in the current book. (Note that sometimes the
  95. approximation is quite inaccurate, especially in the smaller
  96. books.)  You may jump to the beginning or end of the the current
  97. book by dragging the bar to the top or bottom of its field,
  98. respectively.  Or you may place it somewhere in between.
  99.  
  100. To move through the text you may use the cursor keys or the mouse.
  101. Cursor up and down scrolls one line through the text backwards and
  102. forwards, respectively; shift-cursor up and shift-cursor down
  103. scrolls a full screen.  You may also use the arrow gadgets at the
  104. lower-right corner of the window to move one or more lines, and
  105. click above or below the scroll bar to scroll a full screen.
  106.  
  107. You may immediately jump to a specific verse by using the
  108. pull-down menu "Go to Verse" or by hitting right-Amiga (located to
  109. the right of the space bar) G.  Most of the menu items have
  110. right-Amiga key equivalents; you can see what they are by looking
  111. at the menus themselves.
  112.  
  113. A "Go to verse" requester should appear.  You now have to enter the
  114. book, chapter, and verse you want to go to.  If you decide you
  115. don't want to jump to another verse after all, hit the ESCape key
  116. (the most upper-left key on the keyboard) or use the mouse to click
  117. on CANCEL.
  118.  
  119. A book name should be in a pair of brackets towards the bottom of
  120. the requester.  That is the book you would choose if you hit
  121. RETURN/OK.  If it is not the book you want to go to, start typing
  122. in the name of the book you do want.  If you are spelling it
  123. correctly (upper or lower case does not matter here), it should
  124. appear in the brackets before you type the whole name.  Hit
  125. RETURN/OK to choose that book.  If the word "NONE" appears in the
  126. brackets the characters you've typed in do not correspond to any
  127. book of the New Testament or Bible, depending on which version
  128. you are using.  Backspace, and try again.  Or use the cursor up
  129. and down keys (or the requester's scroll bar) to scroll through
  130. the names of the books alphabetically.
  131.  
  132. If you hit RETURN/OK and chose a book but want to back up and
  133. enter a different book, hit the ESCape key or click on CANCEL.
  134.  
  135. You now have to enter the chapter number.  The requester should
  136. now be displaying the number of chapters in your chosen book (1-#
  137. of chapters).  The number in brackets is the default chapter, the
  138. one you pick if you hit RETURN/OK without typing anything in.
  139. Type in the chapter you want to go to and hit RETURN/OK.  Or you
  140. can change the default chapter by using the cursor keys (or scroll
  141. bar), and then hit RETURN/OK.  Cursor up and down will move the
  142. value by one, while shift cursor changes the default to the
  143. minimum and maximum value available in the current book.  Moving
  144. the requester's scroll bar to the top and bottom of its field will
  145. also accomplish this.
  146.  
  147. If you hit RETURN/OK and chose a chapter but want to back up and
  148. enter a different chapter, hit the ESCape key or click on CANCEL.
  149.  
  150. You now have to enter the verse number.  If you were able to
  151. successfully enter the chapter number, you should have no problem
  152. entering the verse; it works exactly the same.  Information
  153. regarding the number of verses in the current chapter is displayed
  154. in the requester; type in the verse you want to go to, or
  155. manipulate the default number in the brackets using the cursor
  156. keys or scroll bar, and hit RETURN/OK.
  157.  
  158. VerseWise should now jump to the book, chapter, and verse you
  159. specified.
  160.  
  161. VerseWise also allows you to define a "bookmark" and jump back to
  162. it.  To place a bookmark, choose "Define Bookmark" under the
  163. "Goto" menu.  It will place it in your current position.  Choose
  164. "Goto Bookmark" to return to this position.  You may jump between
  165. two scriptures by placing a bookmark, going to another scripture,
  166. and choosing "Toggle w/Bookmark".  Note that it is the other
  167. verse (the one you are not at) that is ultimately saved as the
  168. bookmark when you move on.
  169.  
  170. -------------------------------------------------------------------
  171.  
  172. SEARCHING
  173.  
  174. VerseWise allows you to search for verses which contain specific
  175. words.  To do such searches you must define two things:  the
  176. word(s) you want to look for and, if you do not want to search the
  177. whole text, the verses you want to search through.
  178.  
  179. To define words, select the "Word (set)" option in the "Search"
  180. menu (or hit right-Amiga W).  A requester window will appear.
  181. Near the bottom of the requester the word "NONE" is in brackets.
  182. Begin typing in a word you want to look for, and the word in
  183. brackets should change.  Hit RETURN/OK when the word you want
  184. appears. (You may have to type in the whole word.)  If you type in
  185. characters that do not correspond to any word in the Bible the
  186. word "NONE" will reappear in the brackets.  Backspace and try
  187. again.
  188.  
  189. Two notes:  Upper and lower case *do* matter here -- "The" and
  190. "the" are two different words.  Also, be aware that some of the
  191. King James spellings are different than modern day English. (Ie,
  192. "spake" instead of "spoke".)
  193.  
  194. After you've selected the first word you want to look for,
  195. VerseWise asks you for Word #2. (And after that:  #3, #4, etc.)
  196. After defining several words you can scroll through your list of
  197. words by using the up and down cursor keys, or by moving the
  198. requester's scroll bar.  You can delete a word from your list by
  199. hitting the "DELete" key (located in the upper right side of the
  200. keyboard, next to the "HELP" key).  You can change a word by
  201. typing in a new word.  To add more words to your list, go to the
  202. end of the list by hitting RETURN/OK, the down cursor key, or by
  203. moving the scroll bar until "NONE" appears in the brackets.  Then,
  204. enter the word.  To tell VW that you're done defining the word(s)
  205. you want to look for, click on CANCEL, or hit RETURN/OK when the
  206. word "NONE" is in brackets.  The requester will disappear.  Your
  207. words are defined.
  208.  
  209. Note that when you define multiple words, you are telling
  210. VerseWise to look for verses that contain all of the defined
  211. words. (Ie, "look for verses containing word1 AND word2 AND word3
  212. etc.)  Someday VerseWise will let you search for verses containing
  213. "word1 OR word2", or "word1 AND word2 OR word3", etc.
  214.  
  215. By default the range covers all of VerseWise's text. (If you're
  216. running the New Testament version, this is from Matthew 1:1 to
  217. Revelation 22:21, while the full Bible is from Genesis 1:1 to
  218. Revelation 22:21.)  VerseWise does not currently use any
  219. concordance files; it has to physically search the text.  If you
  220. are doing a search through the whole text, this doesn't take more
  221. than a couple of minutes.  However, the search time can be
  222. shortened if you have some idea of where what you're looking for
  223. is and you limit the search to that area. (Ie, if you are looking
  224. for something Jesus said, limit your search to the gospels, or if
  225. you are looking for something Paul said, Acts and the epistles.)
  226.  
  227. To define the range of your search select the "Range (set)" option
  228. in the "Search" menu (or hit right-Amiga R).  You have to enter
  229. two references:  where you want the search to begin, and where you
  230. want the search to end.  The requester displays what the range
  231. currently is, and asks you where to begin the search. (Entering in
  232. the scripture references works the same here as it did in the
  233. above section, "Moving Around".)  After you have typed in the
  234. scripture to begin at, it asks you to enter the scripture to end
  235. at.  The only difference here is that the chapter defaults to the
  236. last chapter in the book, instead of the first, and the verse
  237. defaults to the last verse in the chapter, since searches most
  238. often extend over whole books and chapters. (At least mine do!)
  239.  
  240. A note:  make sure the scripture you want to begin the search is
  241. *before* the scripture you want to end the search.  Nothing
  242. catastrophic will happen; the program will just refuse to do the
  243. search.  It will tell you when it does so for this reason. ("Range
  244. is ill-defined.")
  245.  
  246. Once you've defined the words you want to look for and where you
  247. want to look for them, you are ready to do the actual search.
  248. There are two ways to do searches:  immediate, or to file.
  249.  
  250. Choose the "Next" option in the "Search" menu (or hit right-Amiga
  251. N).  A requester will pop up detailing the search and the pointer
  252. will turn into a timepiece while the search is being conducted.
  253. If a verse containing your defined words is found, VerseWise will
  254. automatically jump there. (If not, a "not found" message will
  255. appear in the search requester.)  When you want to find the next
  256. occurance of your defined words, hit "Next" again. (The "not
  257. found" message will appear in the search requester when there are
  258. no more verses to be found.)
  259.  
  260. If you would like to back up to a previous find, choose the
  261. "Previous" option in the "Search" menu (or hit right-Amiga P), and
  262. VerseWise will jump to the previous find. (If you try to go beyond
  263. the first find, the "not found" message will pop up.)
  264.  
  265. If you move away from the last found verse, for example you "Go
  266. to" another verse, or scroll it off the screen, and want to return
  267. to it, choose the "Current" option in the "Search" menu (or hit
  268. right-Amiga C).
  269.  
  270. VerseWise also lets you direct a search to a text file.  Instead
  271. of jumping you to each individual verse, you may have VW create a
  272. file containing all of the verses you are looking for.  If you
  273. would like to do a search in this manner, activate "To file" in
  274. the Search menu. (If there is a check-mark next to it, it is
  275. activated.)  Begin the search by hitting "Next".  VW will count
  276. the verses it is outputting to the file and let you know when it
  277. is done. (Read more about outputting to a text file, and the
  278. options available to you, in the next section.)
  279.  
  280. You may cancel a search by hitting ESCape/CANCEL at any time.
  281.  
  282. A note:  changing the word, the range definition, or the "To file"
  283. option resets the search. (Ie, it will start over at the beginning
  284. of whatever range you have defined.)
  285.  
  286. -------------------------------------------------------------------
  287.  
  288. OUTPUTTING TEXT
  289.  
  290. VerseWise allows you to output Bible verses as a text file.  There
  291. are two ways to do this:  by screen, and by range.
  292.  
  293. I say "screen", but actually it saves what is in the current
  294. window. (Maybe I get the two mixed up since I usually run
  295. VerseWise with it filling up the whole screen.)  To do this,
  296. choose the "Screen" option in the "Output" menu (or hit
  297. right-Amiga S).  The pointer will change to a timepiece for a
  298. second while the text is being saved.  It will be written to the
  299. specified file.
  300.  
  301. You may also save a specific range of text to a file, from a
  302. couple of verses up to whole books.  Choose the "Range" option in
  303. the "Output" menu (or hit right-Amiga O).  You enter the range
  304. just as you do when you define a range to be searched. (For more
  305. details, read the above section on searching.)  After the range
  306. has been defined, you are given a chance to change your mind. (If
  307. you specified the whole Bible, but do not want a *very* big text
  308. file on your drive, it would be a good idea to do so!)  A
  309. requester pops up detailing the range you want to write to disk,
  310. and the filename you want the text to saved as.  Hit RETURN/OK to
  311. have it continue, ESCape/CANCEL to abort.  You can also hit
  312. ESCape/CANCEL during the output if you want to stop it.
  313.  
  314. As when defining a search range, you must make sure that the
  315. beginning scripture reference of your range is *before* the ending
  316. scripture reference.  If it is not, the range is "ill-defined" and
  317. VerseWise cannot use it.  It will tell you when this is the case.
  318.  
  319. The output filename defaults to "ram:vw_output.txt".  You can
  320. change it by choosing the "File (set)" option in the "Output" menu
  321. (or by hitting right-Amiga F).  I apologize for not having a fancy
  322. file requester here, but I saw it as kind of overkill as this is
  323. the only time one needs to define a file.  VerseWise never has to
  324. load a file, or look for one, since all of the files it needs are
  325. in its current directory, and a file requester would add to its
  326. RAM overhead.
  327.  
  328. "ram:" is the volume it's saving the file to, that is, the Ram
  329. disk. (You can tell it's a volume name by the colon after it.)  If
  330. you want to save a file to a disk volume, change the filename to
  331. "df1:vw_output.txt" or "dh0:vw_output.txt" or whatever, depending
  332. on the disk you want to use.  Or if you'd like to save the file in
  333. the same directory VerseWise is in, do not specify any volume:
  334. "vw_output.txt".  Of course, in all these cases the filename does
  335. not need to be "vw_output.txt".  It may be (almost) anything you
  336. like.
  337.  
  338. There are three configurable options in the "Output" menu: Append,
  339. Formatted, and References.  All of these default to "On". (Thus
  340. the checkmark next to them.)  To turn them off, select them via
  341. the "Output" menu, and the checkmark should disappear.  To turn
  342. them back on, select them again. (Sorry, there are no keyboard
  343. equivalents.)
  344.  
  345. When Append is "on" the text you output will be appended to the
  346. specified file, with a blank line inserted between each output.
  347. Thus, if you run VW and, not changing the filename, do several
  348. screen or range outputs to disk, they will be appended to the file
  349. "ram:vw_output.txt".  If you turn Append "off", each output to
  350. disk will overwrite the previous write, unless you change the
  351. filename for each one.
  352.  
  353. The Formatted option determines how the text is written to disk.
  354. If you turn it "off", there will be no linefeeds (or carriage
  355. returns or whatever those things are) inserted into the text.
  356. Each scripture output will be on its own very long line. (Good if
  357. you want to input the text into a word processor and set your own
  358. margins.)  When Formatted is "on", the output is written to disk
  359. exactly as it appears on the screen.  Thus whenever the output is
  360. Formatted, the line lengths in the text file are the same as they
  361. are in the window.  To change the line lengths of Formatted text,
  362. resize the window accordingly.  I usually size it so there are
  363. about 60 characters on a line.  This works out well for word
  364. processors and bbs's.
  365.  
  366. If you turn References off, the chapter#:verse# will not appear at
  367. the beginning of each verse in the outputted file.  This is useful
  368. if you also have the text unformatted and want to put the
  369. scripture in paragraph form in your word processor, without any
  370. numbers to clutter the text.
  371.  
  372. All of the Output options you choose (including the filename) may
  373. be saved by choosing "Save Prefs" under the "VerseWise"
  374. menu.
  375.  
  376. -------------------------------------------------------------------
  377.  
  378. COPYING & PASTING
  379.  
  380. There are no internal functions in VerseWise to copy scriptures
  381. and paste them directly into word processors or terminal programs.
  382. Using only VerseWise's current functions, you must output text to
  383. a file and load it into your word processor or terminal program
  384. from there.  However, there are several utilities that other
  385. people have written which allow you to use the mouse pointer to
  386. copy text from one window (ie, VerseWise), and paste that text
  387. into any other window (ie, a word processor or a terminal
  388. program).  Two such utilities are "PowerSnap" and "Osnap". Check
  389. your local sources of public domain and shareware software for
  390. these programs, and others like them.
  391.  
  392. -------------------------------------------------------------------
  393.  
  394. A FINAL NOTE
  395.  
  396. Well, this is it.  I apologize if my instructions are unclear in
  397. any points.  Writing documentation is not my favorite pastime, as
  398. those who had to live with the docs I released with the Gospel
  399. version (v1.0) of VerseWise know.  If you have any questions,
  400. comments, suggestions, want to volunteer to rewrite the docs, or
  401. whatever, drop me a line!  I can be reached, at least for the next
  402. six months, at:
  403.  
  404. Bruce Geerdes
  405. 10700 E.Dartmouth #N111
  406. Denver, CO  80014
  407.  
  408. God bless you as you study His word,
  409.  
  410. Bruce
  411.  
  412.  
  413.